/**
 * Copyright 2000 self.com.au
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. (http://www.apache.org/licenses/LICENSE-2.0)
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed 
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for 
 * the specific language governing permissions and limitations under the License.
 *
 * <dhamma-message src="Atisha (11th century Tibetan Buddhist master)">
 * 	The greatest achievement is selflessness. The greatest worth is self-mastery.
 * 	The greatest quality is seeking to serve others. The greatest precept is continual awareness.
 * 	The greatest medicine is the emptiness of everything. The greatest action is not conforming with the worlds ways.
 * 	The greatest magic is transmuting the passions. The greatest generosity is non-attachment.
 * 	The greatest goodness is a peaceful mind. The greatest patience is humility.
 * 	The greatest effort is not concerned with results. The greatest meditation is a mind that lets go.
 * 	The greatest wisdom is seeing through appearances. 
 * </dhamma-message>
 *
 * @author Ashin Wimalajeewa
 */
package self.amigo.elem.uml;

import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;

import org.w3c.dom.DOMException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;

import self.gee.IElementFeature;
import self.lang.BooleanUtils;
import self.lang.StringUtils;
import self.xml.DomUtils;

public class AuxilaryCompartmentFeature implements IElementFeature, Serializable, Cloneable {
	
	/**
	 * If the internal state of this class ever changes in such a way that it can't be defaulted,
	 * then the {@link #serialVersionUID} should be incremented to ensure serialized instances cleanly fail.  
	 */
	private static final long serialVersionUID = 1;
	
  final static public String VISIBLE_PROP = "visible";
  final static public String DETAILS_PROP = "Details";

  public boolean  visible = false;
  public String   details;

  public void set( AuxilaryCompartmentFeature src ) {
    if ( this != src ) {
      visible = src.visible;
      details = src.details;
    }
  }

  public void       getProperties( Map store ) {
    throw new UnsupportedOperationException( "try using aggregate-whole composite property" );
  }

  public void       setProperties( Map data ) {
    throw new UnsupportedOperationException( "try using aggregate-whole composite property" );
  }

  // IPersistentElement support
  public void readFrom( Node self, HashMap idObjLookUp ) throws DOMException {
    String visAsString = DomUtils.getElementAttribute( self, VISIBLE_PROP );
    visible = BooleanUtils.toValue( visAsString );
    Node det = DomUtils.getChildElementNode( self, DETAILS_PROP );
    details = DomUtils.getElementText( det );
  }

  public void writeTo( Document doc, Element self, HashMap objIdLookup ) throws DOMException {
    DomUtils.setElementAttribute( self, VISIBLE_PROP, "" + visible );
    Element det = doc.createElement( DETAILS_PROP );
    self.appendChild( det );
    DomUtils.setElementText( det, StringUtils.toEmptyIfNull(details) );
  }

  public Object clone() {
    try {
      return super.clone();
    } catch (CloneNotSupportedException e) {
      throw new RuntimeException( "err.cloning" );
    }
  }

  public boolean equals( Object other ) {
    if ( !(other instanceof AuxilaryCompartmentFeature) )
      return false;
    AuxilaryCompartmentFeature otherFeature = (AuxilaryCompartmentFeature) other;
    return visible == otherFeature.visible
            && StringUtils.isSameWithNullOrEmpty( details, otherFeature.details )
          ;
  }
}
